account-definitions

List account definitions

SecurityapiAuth

Request

query Parameters

created	string <date-time>
created__gt	string <date-time>
created__gte	string <date-time>
created__lt	string <date-time>
created__lte	string <date-time>
group	string
orderby	Array of strings Ordering `created` - Created `-created` - Created (descending) `name` - Name `-name` - Name (descending) Items Enum: "-created" "-name" "created" "name"
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/account-definitions/

Request samples

Python SDK

rehive.account_definitions.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"label": "string",
"recon": true,
"groups": [{"group": {"name": "string",
"label": "string",
"section": "system"
},
"default": true,
"primary": true,
"currencies": [{"currency": null,
"created": null,
"updated": null
}
],
"created": 0,
"updated": 0
}
],
"updated": 0,
"created": 0
}
]
}
}

Retrieve account definition

SecurityapiAuth

Request

path Parameters

definition_name

required

string^\w+$

Responses

200

get/3/account-definitions/{definition_name}/

Request samples

Python SDK

rehive.account_definitions.get("{id}")

Response samples

application/json

{"status": "success",
"data": {"name": "string",
"label": "string",
"recon": true,
"groups": [{"group": {"name": "string",
"label": "string",
"section": "system"
},
"default": true,
"primary": true,
"currencies": [{"currency": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
},
"created": 0,
"updated": 0
}
],
"created": 0,
"updated": 0
}
],
"updated": 0,
"created": 0
}
}

➔ Next to accounts