Get consumers¶
Returns a collection of consumers.
Prerequisites¶
Credentials as described in Authentication
C#¶
To get consumers, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.
Then call Consumers.Get() method to get the consumers by passing token and the filter.
var filter = new BillingStatementFilter {
OrganizationId = <Organization Id>,
Search = <Search by organization name>,
Page = <page number>,
PageSize = <page size>
};
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.Consumers.Get(token, filter);
Request¶
Request Syntax:
Method |
Request URI |
---|---|
GET |
https://api.crayon.com/api/v1/consumers/?search={search}&organizationId={organizationId}&page={page}&pageSize={pageSize} |
Request Parameters:
Name |
Type |
Description |
---|---|---|
organizationId |
string |
Search by organization id |
search |
string |
Search by organization name |
page |
int |
Pagination, starts at page 1 |
pageSize |
int |
Pagination, Number of objects to return |
Request Headers:
The following HTTP request headers are supported
Header |
Type |
Description |
|
---|---|---|---|
Authorization |
string |
Required. The authorization token in the form Bearer <token>. |
|
Accept |
string |
Specifies the request and response type, “application/json”. |
|
Content-Type |
string |
Specifies the media type of the resource, “application/json”. |
Request Example:
GET $"https://api.crayon.com/api/v1/consumers/?search={search}&organizationId={organizationId}&page={page}&pageSize={pageSize}"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
Response¶
If successful, this method returns a ConsumersCollection resource in the response body.
{
"Items": [
{
"Id": 1001,
"Name": "Alpha Enterprises",
"LegalName": "Alpha Enterprises LLC",
"Organization": {
"Id": 5000,
"Name": "Globex Technologies"
}
},
{
"Id": 1002,
"Name": "Bravo Solutions",
"LegalName": "Bravo Solutions Ltd.",
"Organization": {
"Id": 5000,
"Name": "Globex Technologies"
}
},
{
"Id": 1003,
"Name": "Charlie Innovations",
"LegalName": "Charlie Innovations Inc.",
"Organization": {
"Id": 5000,
"Name": "Globex Technologies"
}
}
],
"TotalHits": 3
}
Response success and error codes:
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.
Error Codes |
Description |
---|---|
200 Ok |
The request has succeeded. |
401 Unauthorized |
The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition. |