Activations

List of Activations

Returns a list of activations for which the user can make API requests. There is a limit to the number of activations which can be returned at one time. If the first request does not return a full list, use the 'next' attribute in the response body to request the next page. By default, activations are returned in batches of 100. The maximum page size is 1000. Provide only valid filters. During filter the activations empty and invalid filter fields are ignored. In case the installer ID doesn’t exist, API will return an empty array.

get/api/v4/partner/activations

Request

Query parameters

nextstring

If the first request does not return a full list, use the 'next' attribute in the response body to request the next page. By default, activations are returned in batches of 100. The maximum page size is 1000. If the returned list below the limit, then response does not include the 'next' field.

limitinteger

There is a limit to the number of activations which can be returned at one time

stagestring

Filter activations by stage. Passing in_progress alone will consider as you have passed all the 1,2,3,4 stages. Passing multiple stage values using comma to filter. E.g. stage=1,2,3. Paasing in_progress with any other combination will give you empty systems. This parameter searches for an exact match of the input value.

referencestring

Filter activations by company reference. This parameter searches for an exact match of the input value and is not case-sensitive.

installer_idinteger

Filter activations by installer id. This parameter searches for an exact match of the input value.

system_namestring

Filter activations by system name. This parameter searches for an exact match of the input value and is not case-sensitive.

citystring

Filter activations by city. This parameter searches for an exact match of the input value and is not case-sensitive.

statestring

Filter activations by state. This parameter searches for an exact match of the input value and is not case-sensitive.

countrystring

Filter activations by country. This parameter searches for an exact match of the input value and is not case-sensitive.

postal_codestring

Filter activations by zipcode. This parameter searches for an exact match of the input value.

street1string

Filter activations by street1. This parameter searches for an exact match of the input value and is not case-sensitive.

street2string

Filter activations by street2. This parameter searches for an exact match of the input value and is not case-sensitive.

host_idinteger

Filter activations by host_id. This parameter searches for an exact match of the input value. In addition to Integers, the filter will support null values too

owner_idinteger

Filter activations by owner_id. This parameter searches for an exact match of the input value. In addition to Integers, the filter will support null values too

Response

OK

nextstring

If the first request does not return a full list, use the 'next' attribute in the response body to request the next page. By default, activations are returned in batches of 10. The maximum page size is 1000

Changes

No recorded changes to this operation across all 1 revision of this API.