Get consumer by id

Returns a single consumer by id

Prerequisites

C#

To get consumer, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call Consumers.GetById() method to get the user by passing token and id.

var id = <user ID>;
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

var result = client.Consumers.GetById(token, id);

Request

Request Syntax:

Method

Request URI

GET

https://api.crayon.com/api/v1/consumers/{id}

Request Parameters:

Name

Type

Description

id

int

Identifier

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/{id}"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >

Response

If successful, this method returns a Consumer resource in the response body.

{
    "Id": 1234,
    "Name": "Name",
    "LegalName": "LegalName",
    "Organization": {
        "Id": 1,
        "Name": "CustomerName"
    }
}

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.