INinfobip
customer-engagement
people
company-profile

Get a single company or a list of companies

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.

get/people/2/companies

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or API key in header Authorization
    • or API key in header Authorization
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Query parameters

namestring

Name of company you want to get.

idinteger

ID of company you want to get.

externalIdstring

External ID of company you want to get.

domainstring

Domain of company you want to get.

limitinteger

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

pageinteger

Page of results to return. Default - 1.

includeTotalCountboolean

Returns total count of companies, if set to true.

orderBystring

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.

filterstring

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

List of supported logical operators:
<table> <thead> <th>Logical Operator</th><th>Description</th> </thead> <tr> <td><code>#and</code></td><td>Joins query clauses with a logical AND returns all records that match the conditions of both clauses.</td> </tr> <tr> <td><code>#or</code></td><td>Joins query clauses with a logical OR returns all records that match the conditions of either clause.</td> </tr> </table>
List of supported comparison operators:
<table> <thead> <th>Comparison Operator</th><th>Supported Type</th><th>Description</th> </thead> <tr> <td><code>#eq</code></td><td>string, integer, decimal, date</td><td>Matches values that are equal to a specified value.</td> </tr> <tr> <td><code>#ne</code></td><td>string, integer, decimal, date</td><td>Matches all values that are not equal to a specified value.</td> </tr> <tr> <td><code>#contains</code></td><td>string</td><td>Matches the records that contain a specified value.</td> </tr> <tr> <td><code>#startsWith</code></td><td>string</td><td>Matches the records that start with a specified value.</td> </tr> <tr> <td><code>#endsWith</code></td><td>string</td><td>Matches the records that end with a specified value.</td> </tr> <tr> <td><code>#gt</code></td><td>integer, decimal, date</td><td>Matches values that are greater than a specified value.</td> </tr> <tr> <td><code>#lt</code></td><td>integer, decimal, date</td><td>Matches values that are less than a specified value.</td> </tr> <tr> <td><code>#gte</code></td><td>integer, decimal, date</td><td>Matches values that are greater than or equal to a specified value.</td> </tr> <tr> <td><code>#lte</code></td><td>integer, decimal, date</td><td>Matches values that are less than or equal to a specified value.</td> </tr> </table>

Response

successful response

limitinteger

Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows)

orderBystring

Results ordering

pageinteger

Page number

totalCountinteger

Total amount of rows

Changes

No recorded changes to this operation across all 1 revision of this API.