Get groupings¶
Returns a list of groupings for an organization. .
Prerequisites¶
Credentials as described in Authentication
C#¶
To get groupings, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.
Then call Groupings.Get() method to get groupings by passing token and filter.
Request¶
Request Syntax:
Method |
Request URI |
---|---|
GET |
https://api.crayon.com/api/v1/groupings/?organizationId={organizationId}&search={search}&page={page}&pageSize={pageSize}&search={search}&includeRemoved={includeRemoved}&invoiceProfileIds={invoiceProfileIds} |
Request Parameters:
Name |
Type |
Required |
Description |
---|---|---|---|
organizationId |
int |
Yes |
Identifier for organization |
search |
string |
No |
Search by grouping name, invoice profile name or customer account name |
page |
int |
No |
Pagination, starts at page 1 |
pageSize |
int |
No |
Pagination, Number of objects to return |
includeRemoved |
bool |
No |
A boolean indicating whether to include removed records |
invoiceProfileIds |
int |
No |
A list of specific invoice profile IDs to filter by |
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/groupings/?organizationId={organizationId}&search={search}&page={page}&pageSize={pageSize}"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
Response¶
If successful, this method returns a collection Grouping resource in the response body.
{
"Items": [
{
"InvoiceProfile": {
"InvoiceAccount": null,
"Id": 12345,
"Name": "Invoice Profile"
},
"Id": 67890,
"Name": "Group Name",
"Organization": {
"Id": 54321,
"Name": "Customer"
},
"CreatedDate": "2025-01-01T10:00:00.000",
"ModifiedDate": "2025-01-01T10:00:00.000",
"IsDisabled": false,
"IsRemoved": false,
"InvoiceReference": "Invoice Reference"
}
],
"TotalHits": 1
}
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. |