GET/projects/api/v3/companies.json

Get all companies.

Retrieve all companies for the provided filters.

On this endpoint you can filter by custom fields. The syntax for the query parameter is the following:

customField[id][op]=value

Where:

  • [id] is the custom field ID
  • [op] is the operator to apply when filtering, different operators are allowed according to the custom field type
  • [value] is the value to apply when filtering

For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following:

customField[10][eq]=Option1

The allowed operators are:

  • like
  • not-like
  • eq
  • not
  • lt
  • gt
  • any

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
    name
    Type
    string
    Description

    filter by exact company name

  • 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
    currencyId
    Type
    integer
    Description

    currency id of the company

  • 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
    includeTentativeProjects
    Type
    boolean
    Description

    retrieve tentative projects

    Default
    false
  • 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
    CompaniesResponse contains information about a group of companies.
  • 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.

Examples

200 OK

CompaniesResponse
{  "companies": [    {      "accounts": 0,      "addressOne": "string",      "addressTwo": "string",      "budgetDistribution": [        {          "color": "string",          "companyId": 0,          "count": 0,          "from": 0,          "to": 0        }      ],      "canSeePrivate": true,      "cid": "string",      "city": "string",
Download Swagger