Get a single company or a list of companies Early access

Use this method with a query parameter to get a single company. If the query parameter is not specified, this method will return a list of companies.

Please log in to see full path URL. Learn why.

get

/people/2/companies

Authorizations:

Scopes:

people:manage

people:read

Request rate limit:

5 requests / second (per account)

Learn more

query Parameters

name

string

Example: name=Infobip

Name of company you want to get.

integer <int64>

Example: id=11351351

ID of company you want to get.

externalId

string

Example: externalId=11351351

External ID of company you want to get.

domain

string

Example: domain=www.infobip.com

Domain of company you want to get.

limit

integer <int32>

Example: limit=20

Number of companies to return per page. Default - 20. Maximum - 1000.

page

integer <int32>

Example: page=1

Page of results to return. Default - 1.

includeTotalCount

boolean

Example: includeTotalCount=false

Returns total count of companies, if set to true.

orderBy

string

Example: orderBy=modifiedAt:desc

Results ordering. Possible ordering fields are name, createdAt and modifiedAt. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.

filter

string

Example: filter={"#or":[{"name":"infobip"},{"#contains":{"notes":"another"}}]}

Allows to filter companies using simple queries. Just pass to the parameter URL encoded query.

List of supported logical operators:

Logical Operator	Description
`#and`	Joins query clauses with a logical AND returns all records that match the conditions of both clauses.
`#or`	Joins query clauses with a logical OR returns all records that match the conditions of either clause.

List of supported comparison operators:

Comparison Operator	Supported Type	Description
`#eq`	string, integer, decimal, date	Matches values that are equal to a specified value.
`#ne`	string, integer, decimal, date	Matches all values that are not equal to a specified value.
`#contains`	string	Matches the records that contain a specified value.
`#startsWith`	string	Matches the records that start with a specified value.
`#endsWith`	string	Matches the records that end with a specified value.
`#gt`	integer, decimal, date	Matches values that are greater than a specified value.
`#lt`	integer, decimal, date	Matches values that are less than a specified value.
`#gte`	integer, decimal, date	Matches values that are greater than or equal to a specified value.
`#lte`	integer, decimal, date	Matches values that are less than or equal to a specified value.

Responses

default

successful response

401

Unauthorized

403

Forbidden

429

Too Many Requests

4XX

Error responses

500

Internal Server Error

5XX

Error responses

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/people/2/companies?name=Infobip&id=11351351&externalId=11351351&domain=www.infobip.com&limit=20&page=1&includeTotalCount=false&orderBy=modifiedAt%3Adesc&filter=%7B%22%23or%22%3A%5B%7B%22name%22%3A%22infobip%22%7D%2C%7B%22%23contains%22%3A%7B%22notes%22%3A%22another%22%7D%7D%5D%7D' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

Example

Copy

Collapse all


{"companies": 
[
{"createdAt": "2017-12-01T19:16:41",
"modifiedAt": "2017-12-01T19:16:41",
"id": 1,
"name": "Infobip",
"notes": "notes example",
"country": "Croatia",
"region": "Europe",
"accountManager": "Jane Smith",
"customerStage": "Active",
"industry": "IT",
"vatNumber": "003212059",
"customAttributes": 
{"Contract Expiry": "2018-06-01"
},
"domains": 
["infobip.com"
],
"origin": "API",
"modifiedFrom": "API"
}
]
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use