Skip to main content

Get Organizations

Used to retrieve a paginated list of organizations with support for filtering, sorting, and searching.

API Endpoint

PropertyValue
Request MethodGET
Request URLhttps://api.seliseblocks.com/idp/v1/Iam/GetOrganizations

Request

Request Example

curl -X GET 'https://api.seliseblocks.com/idp/v1/Iam/GetOrganizations?ProjectKey=YOUR_PROJECT_KEY&Page=1&PageSize=10&Sort.Property=createdDate&Sort.IsDescending=true&Filter.Name=Acme' \
-H 'x-blocks-key: YOUR_PROJECT_KEY'

Request Headers

FieldTypeDescription
x-blocks-keystringProject key for authentication.

Query Parameters

FieldTypeRequiredDescription
ProjectKeystringYesThe project key for filtering results.
PageintegerNoPage number for pagination (1-based).
PageSizeintegerNoNumber of records per page.
Sort.PropertystringNoProperty to sort by.
Sort.IsDescendingbooleanNoSort in descending order if true.
Filter.NamestringNoFilter by organization name.
Filter.IsEnablebooleanNoFilter by enabled status.
Filter.ItemIdstringNoFilter by organization ID.
Filter.CreatedDatestring(date-time)NoFilter by creation date.
Filter.LastUpdatedDatestring(date-time)NoFilter by last update date.
Filter.CreatedBystringNoFilter by creator.
Filter.LanguagestringNoFilter by language.
Filter.LastUpdatedBystringNoFilter by last updater.
Filter.OrganizationIdsarrayNoFilter by specific organization IDs.
Filter.TagsarrayNoFilter by tags.

Response

Success Response

Returns HTTP status 200 OK with paginated organizations list.

{
"errors": {},
"isSuccess": true,
"organizations": [
{
"itemId": "org_123",
"createdDate": "2026-01-15T10:30:00Z",
"lastUpdatedDate": "2026-03-20T14:00:00Z",
"createdBy": "admin_user",
"language": "en-US",
"lastUpdatedBy": "admin_user",
"organizationIds": ["org_123", "org_parent"],
"tags": ["enterprise", "active"],
"name": "Acme Corporation",
"isEnable": true
}
],
"totalCount": 1
}

Response Fields

FieldTypeDescription
errorsobjectAny errors encountered during retrieval.
isSuccessbooleanIndicates if retrieval was successful.
organizationsarrayList of organization objects.
totalCountintegerTotal count of organizations matching filter.

Organization Object Fields

FieldTypeDescription
itemIdstringUnique organization identifier.
createdDatestring(date-time)Organization creation date.
lastUpdatedDatestring(date-time)Last update date.
createdBystringUser who created the organization.
languagestringOrganization's preferred language.
lastUpdatedBystringUser who last updated organization.
organizationIdsarrayList of organization IDs.
tagsarrayTags associated with organization.
namestringOrganization name.
isEnablebooleanWhether organization is enabled.