Get addresses

Returns a collection of invoice addresses and/or delivery addresses


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


To get invoice or delivery addresses, first create the instance of CrayonApiClient and get the token using the instance.

Then call Addresses.Get() method to get invoice or delivery addresses by passing the token, organization id and address type.

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

var result = client.Addresses.Get(token, organizationId, addressType);


Request Syntax:

Method Request URI

Request Parameters:

Name Type Description
organizationId int Identifier of the company to get invoice /delivery addresses for
type int 1=Invoice addresses, 2=Delivery addresses

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


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

  "Items": [
      "Id": 5637147808,
      "Organization": {
        "Id": 4703,
        "Name": "My company"
      "Name": "My company",
      "CompleteAddress": "Some address 45\n81132 Stockholm",
      "Street": "Street 45",
      "ZipCode": "12345",
      "City": "Stockholm",
      "County": "",
      "State": "",
      "CountryCode": "SE",
      "Primary": true,
      "AddressType": 1
  "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.
400 Bad Request The request could not be understood by the server due to malformed syntax, missing required properties, properties that couldn’t be parsed according to their type (and length). It is a non-retryable error condition. The client should not repeat the request without modifications.
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.