v1

latestOpenAPI 3.0.12026-08-063985821.3 MB

Company API:Companies

Get a company

get/companies/{companyId}

Path parameters

companyIdinteger required

Company Id

Query parameters

Embedstring[]

Embed related resources.<br /> Resources available to embed are: addresses, contacts, subsidiaries, skills, notes, jobs, placements, workflows

Response

Requested company details

companyIdinteger required

Unique identifier for the company

namestring nullable

Company name

legalNamestring nullable

socialobject nullable

Company social profiles

summarystring nullable

createdAtstring date-time nullable

updatedAtstring date-time nullable

Example response

{
  "social": {
    "facebook": "https://www.facebook.com/JobAdder",
    "twitter": "https://twitter.com/jobadder",
    "linkedin": "https://www.linkedin.com/company/866656/"
  },
  "custom": [
    {
      "fieldId": 1,
      "name": "Text Field 1",
      "type": "Text",
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "name": "List Field 2",
      "type": "List",
      "value": [
        "Value 1",
        "Value 2"
      ]
    },
    {
      "fieldId": 3,
      "name": "Date Field 3",
      "type": "Date",
      "value": "2018-07-01"
    }
  ]
}