GET Companies Single/Multiple by IDs

Syntax

The following request is used to retrieve a companies objects by specifying company IDs :

Note: The parameters highlighted in red are placeholders for the mandatory values described bellow.

Single Company

http://api.vidible.tv/COMPANY_KEY/company/COMPANY_ID?PARAMETERS

Multiple Companies

http://api.vidible.tv/COMPANY_KEY/company/COMPANY_ID,COMPANY_ID?PARAMETERS
  • COMPANY_KEY - Replace this placeholder with your Company key.
    Note: If you do not have a Company key, please contact our Support team by clicking here.

  • COMPANY_ID - Replace this placeholder with the required Company ID you want to retrieve.
    Note: To obtain your Company ID, please see How to find your Company ID.

  • PARAMETERS - Please refer to the following parameters section to apply any additional query parameters to the request.

 

 

Parameters

The following parameters and values can be added to the request.

Note: Use a question mark '?' to open the query and ad a parameter and value. 


Note: Use the ampersands sign '&' to add multiple parameters and values one after the other within the query string.

 

Parameter Description Value
offset

Enter a numeric value from 0 and up to define how many company results will be skipped from the beginning of the result list.

Note: For example, Specifying two Company IDs in the request and setting the offset filed to 1 will return the second company data only in the response. 

offset=number

offset=1

limit

Enter a numeric value from 0 and up to define how many company results will be returned in the response.

Note: For example, Specifying three Company IDs in the request and setting the offset filed to 2 will only return the first two companies in the response.

limit=number

limit=2

 

 

Try it out by clicking here.

 

Examples

Request without Parameters

Description: This method is used to retrieve company details without any query string parameters.

Method: GET

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/company/57415bf1e4b00e9b250d0ac8,56d84746e4b0558a22bf8f75

Response

[
{
"id": "57415bf1e4b00e9b250d0ac8",
"name": "1st Affiliate",
"creationDate": 1463901169609,
"modificationDate": 1463901554791
},
{
"id": "56d84746e4b0558a22bf8f75",
"name": "3rd Affiliate",
"creationDate": 1457014605697,
"modificationDate": 1463072620602
}
]

 

 

Request with Query Parameters

Description: This method is used to retrieve company details including additional query string parameters.

Method: GET

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/company/57415bf1e4b00e9b250d0ac8%2C56d84746e4b0558a22bf8f75%2C5729a9b2e4b076d396031f45?offset=1&limit=3

Response

[
{
"id": "5729a9b2e4b076d396031f45",
"name": "2nd Affiliate",
"creationDate": 1462348210483,
"modificationDate": 1462348210483
},
{
"id": "56d84746e4b0558a22bf8f75",
"name": "3rd Affiliate",
"creationDate": 1457014605697,
"modificationDate": 1463072620602
}
]
Have more questions? Submit a request