GET v2/businesses/list

Receive a list of your processes, ordered by creation time in a descending order.

You need to login with a user and api key in order to access this method.
Add this HTTP header to your request:
Authorization: Bearer <Your-Login-Token>
Not sure how to generate your login token? Read here.

Parameters

Input

NameDescriptionTypeAdditional information
offset

The process to start the count from.
For example, 100 means that the newest 100 processes will be ignored from the count.

unsigned int

Required

total

Total number of processes you receive at once.

unsigned int

Valid range 1-1000.

Output

NameDescriptionTypeAdditional information
total

Total number of results from the server.

unsigned int

None.

results
NameDescriptionTypeAdditional information
id

Copyleaks processs ID

globally unique identifier

None.

Example

Request

cURL

Sample:
curl -X GET "https://api.copyleaks.com/v2/businesses/list?total=100&offset=0" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR-TOKEN"

Response

application/json, text/json

Sample:
{
	"total": 6,
	"results": [{
			"id": "a8e3d482-c38d-4843-a02c-e1f3e1f63632"
		}, {
			"id": "b900242f-f892-4ab6-a37b-83fc0927ed35"
		}, {
			"id": "c62ef9a3-168c-4f89-9ee2-bd8f6e19be8b"
		}, {
			"id": "a79ff8c8-4831-4cf7-9d99-acc0da7a5bf0"
		}, {
			"id": "a135ebcf-18b7-4c86-baae-a53953395325"
		}, {
			"id": "s0437763-eceb-4324-b844-bf49e08ab892"
		}
	]
}

Common Errors

Error Code Error Message
37 Authorization has been denied for this request.

Other errors?

For more information, see the full errors list.

Deprecated Versions