GET/projects/api/v3/companies/{companyId}.json

Get a specific company.

Retrieves a company by id.

Path Params

  • Name
    companyId
    Type
    integer
    required
    Description

Query Params

  • Name
    updatedAfterDate
    Type
    string
    Description

    filter by updated after date (deprecated, use updatedAfter)

  • Name
    updatedAfter
    Type
    string
    Description

    filter by updated after date

  • Name
    searchTerm
    Type
    string
    Description

    filter by company name and description

  • Name
    reportType
    Type
    string
    Description

    define the type of the report

    Default
    company
    Allowed values
    • company
    • client
  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    ownercompany
    Allowed values
    • name
    • accounts
    • clients
    • collaborators
    • contacts
    • projects
    • tasks
    • country
    • health
    • website
    • email
    • phone
    • fax
    • industry
    • dateadded
    • ownercompany
    • ownername
    • taskscompletion
    • customfield
  • Name
    minLastActivityDate
    Type
    string
    Description

    filter by companies after their projects activity date

  • Name
    maxLastActivityDate
    Type
    string
    Description

    filter by companies before their projects activity date

  • Name
    firstLetter
    Type
    string
    Description

    filter by first letter of company name

  • Name
    createdAfterDate
    Type
    string
    Description

    filter by created after date (deprecated, use createdAfter)

  • Name
    createdAfter
    Type
    string
    Description

    filter by created after date

  • Name
    budgetRanges
    Type
    string
    Description

    budget distribution ranges

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    orderByCustomFieldId
    Type
    integer
    Description

    order by custom field id when orderBy is equal to customfield

  • Name
    useFormulaFields
    Type
    boolean
    Description

    use formula fields

  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    searchClientManagers
    Type
    boolean
    Description

    include client managers in the search

  • Name
    returnLetters
    Type
    boolean
    Description

    return unfiltered company initial letter counts

    Default
    false
  • Name
    onlyUntaggedCompanies
    Type
    boolean
    Description

    only untagged companies

  • Name
    matchAllTags
    Type
    boolean
    Description

    match all tags

  • Name
    matchAllExcludedTags
    Type
    boolean
    Description

    match all exclude tags

  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report document

  • Name
    includeUntaggedCompanies
    Type
    boolean
    Description

    include untagged companies

  • Name
    includeProfitability
    Type
    boolean
    Description

    include profitability data for each client

    Default
    false
  • Name
    includeCustomFields
    Type
    boolean
    Description

    include custom fields

    Default
    false
  • Name
    includeBudgetSummary
    Type
    boolean
    Description

    include budget summary

    Default
    false
  • Name
    includeBudgetDistribution
    Type
    boolean
    Description

    include budget distribution data

    Default
    false
  • Name
    getStats
    Type
    boolean
    Description

    include stats of company tasks and projects

    Default
    false
  • Name
    getEmoji
    Type
    boolean
    Description

    parse emojis to unicode

    Default
    true
  • Name
    fullProfile
    Type
    boolean
    Description

    include full profile

  • Name
    excludeOwnerCompany
    Type
    boolean
    Description

    exclude the owner company

  • Name
    tagIds
    Type
    array[integer]
    Description

    filter by tag ids

    Format
    Comma separated values
  • Name
    selectedColumns
    Type
    array[string]
    Description

    customise the report by selecting columns

    Format
    Comma separated values
  • Name
    projectStatuses
    Type
    array[string]
    Description

    filter by project statuses

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • tags
    • countries
    • industries
    • clientmanagedby
    • companyupdates
  • Name
    ids
    Type
    array[integer]
    Description

    filter by ids

    Format
    Comma separated values
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[tags]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • count
  • Name
    fields[industries]
    Type
    array[string]
    Description
    Format
    Comma separated values
  • Name
    fields[countries]
    Type
    array[string]
    Description
    Format
    Comma separated values
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • Name
    excludeTagIds
    Type
    array[integer]
    Description

    filter by excluded tag ids

    Format
    Comma separated values
  • Name
    excludeIds
    Type
    array[integer]
    Description

    exclude by company ids

    Format
    Comma separated values
  • Name
    companyHealths
    Type
    array[integer]
    Description

    filter by company statuses

    Format
    Comma separated values
  • Name
    clientManagedByUserIds
    Type
    array[integer]
    Description

    filter by client manager user ids

    Format
    Comma separated values
  • Name
    CustomFields
    Type
    array[string]
    Description

    filter by custom fields

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    Response contains information about a specific company.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    404
    Type
    object
    Schema
    Description
    404 Not Found
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

Response
{
  "company": {
    "accounts": 0,
    "addressOne": "string",
    "addressTwo": "string",
    "budgetDistribution": [
      {
        "color": "string",
        "companyId": 0,
        "count": 0,
        "from": 0,
        "to": 0
      }
    ],
    "canSeePrivate": true,
    "cid": "string",
    "city": "string",
    "clientManagedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "clients": 0,
    "collaborators": 0,
    "companyDomains": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "companyNameUrl": "string",
    "companyUpdate": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "contacts": 0,
    "countryCode": "string",
    "createdAt": "string",
    "emailOne": "string",
    "emailThree": "string",
    "emailTwo": "string",
    "fax": "string",
    "financialBudgetSummary": {
      "totalCapacity": 0,
      "totalCapacityUsed": 0
    },
    "id": 0,
    "industry": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "industryId": 0,
    "isOwner": true,
    "logoUrl": "string",
    "name": "string",
    "phone": "string",
    "privateNotes": "string",
    "privateNotesText": "string",
    "profileText": "string",
    "profitability": {
      "billable": 0,
      "billableTime": 0,
      "companyCount": 0,
      "cost": 0,
      "expenses": 0,
      "loggedTime": 0,
      "nonBillableTime": 0,
      "ownerCount": 0,
      "profit": 0
    },
    "state": "string",
    "stats": {
      "projectCount": 0,
      "taskCompleteCount": 0,
      "taskCount": 0,
      "unreadEmailCount": 0
    },
    "status": "string",
    "tags": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "timeBudgetSummary": {
      "totalCapacity": 0,
      "totalCapacityUsed": 0
    },
    "updatedAt": "string",
    "website": "string",
    "zip": "string"
  },
  "included": {
    "countries": {
      "additionalProp": {
        "code": "string",
        "country": "string",
        "eu": true,
        "phoneCode": "string",
        "vatName": "string",
        "vatPercent": 0
      }
    },
    "customfieldCompanies": {
      "additionalProp": {
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "countryCode": "string",
        "createdAt": "string",
        "createdBy": 0,
        "currencySymbol": "string",
        "customfield": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "customfieldId": 0,
        "id": 0,
        "urlTextToDisplay": "string"
      }
    },
    "customfields": {
      "additionalProp": {
        "createdAt": "string",
        "createdBy": 0,
        "createdByUserId": 0,
        "currencyCode": "string",
        "deleted": true,
        "deletedAt": "string",
        "deletedBy": 0,
        "deletedByUserId": 0,
        "description": "string",
        "entity": "string",
        "formula": "string",
        "groupId": 0,
        "id": 0,
        "isPrivate": true,
        "name": "string",
        "project": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "projectId": 0,
        "required": true,
        "type": "string",
        "unitId": 0,
        "updatedAt": "string",
        "updatedBy": 0,
        "updatedByUserId": 0,
        "visibilities": [
          "string"
        ]
      }
    },
    "domains": {
      "additionalProp": {
        "companyId": 0,
        "createdAt": "string",
        "createdByUser": 0,
        "deletedAt": "string",
        "deletedByUser": 0,
        "domain": "string",
        "id": 0,
        "state": "string",
        "updatedAt": "string",
        "updatedByUser": 0
      }
    },
    "industries": {
      "additionalProp": {
        "displayOrder": 0,
        "id": 0,
        "industryCategory": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "industryCategoryId": 0,
        "isActive": true,
        "isPublished": true,
        "name": "string"
      }
    },
    "tags": {
      "additionalProp": {
        "color": "string",
        "count": 0,
        "id": 0,
        "name": "string",
        "project": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "projectId": 0
      }
    },
    "updates": {
      "additionalProp": {
        "active": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "health": 0,
        "id": 0,
        "text": "string"
      }
    },
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAddProjects": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isPlaceholderResource": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userCost": 0,
        "userRate": 0,
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  }
}
Download Swagger