Get address

Returns a single address


  • Credentials as described in Authentication
  • An organization identifier
  • an address identifier


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

Then call Addresses.Get() method to get an address by passing token, organization id and the address id.

var client = new CrayonApiClient("");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var organizationId = <your organization id>;
var addressId = <address identifier>;

var result = client.Addresses.GetById(token, organizationId, addressId);


Request Syntax:

Method Request URI

Request Parameters:

Name Type Description
organizationId int Identifier of the company
id long Identifier of the address

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


If successful, this method returns an Address resource in the response body.

  "Id": 1,
  "Organization": {
    "Id": 2,
    "Name": "My company AB"
  "Name": "My company",
  "CompleteAddress": "My company, Street name 3 City 156489 Sweden",
  "Street": "Street name 3",
  "ZipCode": "123456",
  "City": "City",
  "County": "",
  "State": "",
  "CountryCode": "SE",
  "Primary": true,
  "AddressType": 2

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.
404 NotFound Address was not found.