Field | Type | Required | Description | Example |
---|---|---|---|---|
Limit |
long | ➖ | Applies a limit to the number of results returned. Can be used for paginating the results together with offset . |
20 |
Offset |
long | ➖ | Skip the first offset results when paginating.Needs to be an integer greater or equal to zero. To be used in conjunction with limit . |
10 |
IncludeMembersCount |
bool | ➖ | Flag to denote whether the member counts of each organization should be included in the response or not. | false |
Query |
string | ➖ | Returns organizations with ID, name, or slug that match the given query. Uses exact match for organization ID and partial match for name and slug. |
clerk |
OrderBy |
string | ➖ | Allows to return organizations in a particular order. At the moment, you can order the returned organizations either by their name , created_at or members_count .In order to specify the direction, you can use the +/- symbols prepended in the property to order by.For example, if you want organizations to be returned in descending order according to their created_at property, you can use -created_at .If you don't use + or - , then + is implied.Defaults to -created_at . |
-name |