List All Reason Codes

Retrieves all Reason Codes.

HTTP Request

GET https://api.vindicia.com/reason_codes

Route (URL) Parameters

None.

Query Parameters

Parameter	Default	Description	Required
limit	20	A limit on the number of objects to be returned, between 1 and 100.	No
starting_after	none	A cursor for use in pagination. starting_after is an object id that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.	No
ending_before	none	A cursor for use in pagination. ending_before is an object id that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.	No
reason_type	none	The reason type to return.	No

Accepts

None.

Returns

JSON - A list array with a data property that contains an array of up to limit Reason Codes, starting after the specified starting_after Reason Code (or ending before the specified ending_before Reason Code). Each entry in the array is a full Reason Code object. If no more Reason Code are available, the resulting array will be empty. This request should never throw an error. A list of The Reason Code Object objects matching the query. Also:

“total_count”: Integer count of the number of Reason Codes in the returned list.
“url”: The query string provided in the request
“next”: The route (partial URL) to the next Reason Code object (string to select the “next”); included id should match that of the last object returned here
“previous”: The route (partial URL) to the previous Reason Code object (string to select the “previous”); included id should match that of the first object returned here

Parent topic:Reason Codes

Home

Guides

APIs

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns

​HTTP Request

​Route (URL) Parameters

​Query Parameters

​Accepts

​Returns

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns