Top
Top
  1. Workamajig
  2. IT Info
  3. API Info

Articles in this section

API: Companies

Methods

Retrieve a company

GET /companies?companyKey=
Parameters
companyKey: required  <the key of the company you're looking for>
Example Request
https://workamajig.com/api/beta1/companies?companyKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090
Example Response
{
    "logid": "091e30c1-26b6-429c-8d62-2a64ebad9f52",
    "data": {
        "company": {
            "Fax": "asfasf",
            "CompanyTypeName": null,
            "BillableClient": 0,
            "ContactOwnerKey": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "LastModified": "2015-04-02T12:06:00",
            "ModifiedByName": "Greg O'Geiger",
            "OnHold": 0,
            "Vendor": 0,
            "CompanyKey": "YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090",
            "ModifiedBy": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "DateUpdated": "2015-04-02T16:06:00",
            "NextActivitySubject": "Short",
            "CreatedByName": "Greg O'Geiger",
            "WebSite": "PepsiCo.com",
            "ParentCompany": 0,
            "DateAdded": "2015-02-03T15:07:00",
            "CreatedBy": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "ContactCount": 0,
            "IsFavorite": 1,
            "CompanyName": "Pepsi Colo",
            "Active": 1,
            "NextProjectNum": 1,
            "AccountManagerKey": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "NextActivityDate": "2015-03-18T20:00:00",
            "AccountManagerName": "Greg O'Geiger",
            "Phone": null,
            "ContactOwnerName": "Greg O'Geiger",
            "NextActivityAssignedTo": "Greg O'Geiger",
            "OwnerCompanyKey": "SnRwMWdBSjRPQU9HZlcwa1VqaStaUT090",
            "NextActivityKey": "b2lmdi93VUJ1eWVpQXlRVVZJMmJadz090"
        }
    }
}
 

Search companies

GET /companies/search?text={something}
Parameters
text: required <replace the {something} with text you're looking for >
Example Request
https://workamajig.com/api/beta1/companies/search?text=software
Example Response
{
    "logid": "62adf017-ebf2-453b-9059-c96f23d0378e",
    "data": {
        "company": [
            {
                "Fax": null,
                "CompanyTypeName": null,
                "BillableClient": 0,
                "ContactOwnerKey": "MHNxTjZIWkhRR1VNa1hPa0tiSTRiUT090",
                "LastModified": "2008-04-03T15:29:00",
                "ModifiedByName": null,
                "OnHold": null,
                "Vendor": 1,
                "CompanyKey": "dEwwM3ZBaDhuZWxlUXlzZ3l4bWJ4Zz090",
                "ModifiedBy": "",
                "DateUpdated": "2003-12-29T18:56:00",
                "NextActivitySubject": null,
                "CreatedByName": null,
                "WebSite": null,
                "ParentCompany": 0,
                "DateAdded": "2003-12-29T18:54:00",
                "CreatedBy": "",
                "ContactCount": 0,
                "IsFavorite": 0,
                "CompanyName": "Best Software, Inc.",
                "Active": 1,
                "NextProjectNum": 1,
                "AccountManagerKey": "",
                "NextActivityDate": null,
                "AccountManagerName": null,
                "Phone": null,
                "ContactOwnerName": "Todd Cantu",
                "NextActivityAssignedTo": null,
                "OwnerCompanyKey": "SnRwMWdBSjRPQU9HZlcwa1VqaStaUT090",
                "NextActivityKey": ""
            },
            {
                "Fax": null,
                "CompanyTypeName": null,
                "BillableClient": 0,
                "ContactOwnerKey": "MHNxTjZIWkhRR1VNa1hPa0tiSTRiUT090",
                "LastModified": "2008-04-03T15:29:00",
                "ModifiedByName": null,
                "OnHold": null,
                "Vendor": 1,
                "CompanyKey": "S2lxUEtOMmJjTlV0L1ludS9TQzdGZz090",
                "ModifiedBy": "",
                "DateUpdated": "2003-12-29T18:56:00",
                "NextActivitySubject": null,
                "CreatedByName": null,
                "WebSite": null,
                "ParentCompany": 0,
                "DateAdded": "2003-12-29T18:54:00",
                "CreatedBy": "",
                "ContactCount": 0,
                "IsFavorite": 0,
                "CompanyName": "Comframe Software Corporation",
                "Active": 1,
                "NextProjectNum": 1,
                "AccountManagerKey": "",
                "NextActivityDate": null,
                "AccountManagerName": null,
                "Phone": null,
                "ContactOwnerName": "Todd Cantu",
                "NextActivityAssignedTo": null,
                "OwnerCompanyKey": "SnRwMWdBSjRPQU9HZlcwa1VqaStaUT090",
                "NextActivityKey": ""
            },
            {
                "Fax": null,
                "CompanyTypeName": null,
                "BillableClient": null,
                "ContactOwnerKey": "MHNxTjZIWkhRR1VNa1hPa0tiSTRiUT090",
                "LastModified": "2008-04-03T15:29:00",
                "ModifiedByName": null,
                "OnHold": null,
                "Vendor": 0,
                "CompanyKey": "eDRUOUNGc21JekNGcCthaDA5RGpVQT090",
                "ModifiedBy": "",
                "DateUpdated": "2004-11-02T09:42:00",
                "NextActivitySubject": null,
                "CreatedByName": null,
                "WebSite": null,
                "ParentCompany": 0,
                "DateAdded": "2004-11-02T09:14:00",
                "CreatedBy": "",
                "ContactCount": 1,
                "IsFavorite": 0,
                "CompanyName": "Sage Software",
                "Active": 1,
                "NextProjectNum": 1,
                "AccountManagerKey": "",
                "NextActivityDate": null,
                "AccountManagerName": null,
                "Phone": null,
                "ContactOwnerName": "Todd Cantu",
                "NextActivityAssignedTo": null,
                "OwnerCompanyKey": "SnRwMWdBSjRPQU9HZlcwa1VqaStaUT090",
                "NextActivityKey": ""
            },
            {
                "Fax": null,
                "CompanyTypeName": null,
                "BillableClient": null,
                "ContactOwnerKey": "MHNxTjZIWkhRR1VNa1hPa0tiSTRiUT090",
                "LastModified": "2008-04-03T15:29:00",
                "ModifiedByName": null,
                "OnHold": null,
                "Vendor": 0,
                "CompanyKey": "OFI3alNjb2lWOVNodndYWHlEYmlWUT090",
                "ModifiedBy": "",
                "DateUpdated": "2004-11-02T09:42:00",
                "NextActivitySubject": null,
                "CreatedByName": null,
                "WebSite": null,
                "ParentCompany": 0,
                "DateAdded": "2004-11-02T09:14:00",
                "CreatedBy": "",
                "ContactCount": 1,
                "IsFavorite": 0,
                "CompanyName": "Software Solutions",
                "Active": 1,
                "NextProjectNum": 1,
                "AccountManagerKey": "",
                "NextActivityDate": null,
                "AccountManagerName": null,
                "Phone": null,
                "ContactOwnerName": "Todd Cantu",
                "NextActivityAssignedTo": null,
                "OwnerCompanyKey": "SnRwMWdBSjRPQU9HZlcwa1VqaStaUT090",
                "NextActivityKey": ""
            }
        ]
    }
}
 

Create a new company

POST /companies/
Parameters
companyName: required
primaryContact: optional <This is where you determine who of the linked contacts will be the primary for the purposes of routing of projects and approvals on the client side.>
phone: optional
fax: optional
website: optional
contactOwnerKey: optional <Select from existing staff member, who will act as the owner for this company.  Will be defaulted to the owner of the UserToken.>
accountManagerKey: optional <Select from existing staff member who will default into Project setup as the Account Manager. Will be defaulted to the owner of the UserToken.>
salesPersonKey: optional <Select from existing staff members who is the designated Salesperson for the company.>
comments: optional
address1: optional
address2: optional
city: optional
state: optional
postalCode: optional
country: optional

 

Example Request
https://workamajig.com/api/beta1/companies/
[
 {
    "companyName":"William Sonoma",
    "phone":"1.702.363.2543",
    "fax":"",
    "website":"www.williams-sonoma.com",
    "active":"1",
    "comments":"Make Williams-Sonoma your source for gourmet foods and professional-quality cookware. Choose small kitchen appliances, cooking utensils and decor that ...",
    "address1":"2458 Williams Way",
    "address2":"Suite 1001",
    "city":"Miami",
    "state":"FL",
    "postalCode":"31256",
    "country":"USA",
 }
]
Example Response
{
    "success": [
        {
            "companyKey": "MUE5UHFFZVhTNmd0V2VXTHhrbGgxZz090",
            "data": {
                "address2": "Suite 1001",
                "companyName": "William Sonoma",
                "comments": "Make Williams-Sonoma your source for gourmet foods and professional-quality cookware. Choose small kitchen appliances, cooking utensils and decor that ...",
                "active": "1",
                "country": "USA",
                "state": "FL",
                "phone": "1.702.363.2543",
                "address1": "2458 Williams Way",
                "city": "Miami",
                "postalCode": "31256",
                "website": "www.williams-sonoma.com",
                "fax": ""
            }
        }
    ],
    "logid": "0dce0dae-fda2-4f13-8634-b0713054ea53"
}

 

Update a company

PUT /companies/

NOTE: If a companyName is supplied without a companyKey we'll try to find an existing match using the name field. If we do not find an existing company, a new one will be created.

Parameters
companyKey: required if companyname missing <unique identifier for the company to be updated>
companyName: required if the company is not supplied
primary contact: optional <This is where you determine who of the linked contacts will be the primary for the purposes of routing of projects and approvals on the client side.>
phone: optional
fax: optional
website: optional
contactOwnerKey: optional <Select from existing staff member, who will act as the owner for this company.  Will be defaulted to the owner of the UserToken.>
accountManagerKey: optional <Select from existing staff member who will default into Project setup as the Account Manager. Will be defaulted to the owner of the UserToken.>
salesPersonKey: optional <Select from existing staff members who is the designated Salesperson for the company.>
comments: optional
address1: optional
address2: optional
city: optional
state: optional
postalCode: optional
country: optional

 

Example Request
https://workamajig.com/api/beta1/companies/
[
 {
    "companyKey":"Q0lCb2tseFo0Qk5YVUFtYWhlSzlrZz090",
    "companyName":"William Sonoma",
    "phone":"1.702.363.2543",
    "fax":"",
    "website":"www.williams-sonoma.com",
    "active":"1",
    "comments":"Make Williams-Sonoma your source for gourmet foods and professional-quality cookware. Choose small kitchen appliances, cooking utensils and decor that ...",
    "address1":"2458 Williams Way",
    "address2":"Suite 1001",
    "city":"Miami",
    "state":"FL",
    "postalCode":"31256",
    "country":"USA",
 }
]
Example Response
{
  "success": [
    {
      "companyKey": "Q0lCb2tseFo0Qk5YVUFtYWhlSzlrZz090"
    }
  ],
  "logid": "a092f926-5ba0-4b4e-a2b8-647dc5a0137f"
}

 

Delete a company

DELETE /companies
Parameters
companyKey: required <unique identifier for the company to be deleted>
 
Example Request
https://workamajig.com/api/beta1/companies/
[
 {"companyKey":"WnUvQW5tQm5SZkRFQ2hEbVRWS05SUT090" }
]
Example Response
{
  "success": [
    { "companyKey": "WnUvQW5tQm5SZkRFQ2hEbVRWS05SUT090"}
  ],
  "logid": "7f242f0a-7950-4435-a5d2-3381ce8da61d"
}

Related articles