Get groupings
=============

Returns a list of groupings for an organization.
.

Prerequisites
^^^^^^^^^^^^^

- Credentials as described in :doc:`/getting-started/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.

.. code-block:: c#
	:emphasize-lines: 13
	
    var filter = new GroupingFilter
    {
        OrganizationId = <The unique ID of the organization. Used to scope the data to a specific organization.>,           
        IncludeRemoved = <A boolean indicating whether to include removed records>,
        Page = <The page number for pagination>,
        PageSize = <The number of items to retrieve per page>,
        InvoiceProfileIds = <A list of specific invoice profile IDs to filter by>,
        Search = <A search string for filtering results based on name, reference, or other searchable fields>
    };

	var client = new CrayonApiClient("https://api.crayon.com/");
	var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
	var result = client.Groupings.Get(token, 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 :doc:`/resources/Grouping` resource in the response body.

.. literalinclude:: /resources/_static/GroupingCollection.json
        :language: json
	
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.                                      |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+