Retrieve a specific organization
Fetch the details of a specific organization by providing its unique ID.
GET
Parameters
Path Parameters
OrganizationId
REQUIRED
Unique identifier of the organization
| Status code | Description |
|---|---|
| 200 | Successfully retrieved the organization details. |
| 400 | Bad request error - the request contains invalid parameters or malformed data |
| 500 | Internal server error - an unexpected error occurred on the server |
cURL
curl -L \"https://blockv-labs.io/organizations/{organizationId}" \-H 'Accept: application/json'
Response
{"id": "string","fqdn": "string","name": "string","image": {"id": "string","name": "string","type": "string","url": "string","hash": "string","is_public": false,"when_created": "2024-01-01T00:00:00Z"},"members": [{"id": "string","wallet_id": "string","email": "string","invite_status": "pending","role_name": "string","when_created": "2024-01-01T00:00:00Z","when_modified": "2024-01-01T00:00:00Z"}],"roles": [{"id": "string","name": "string","description": "string","permissions": [{"resource": "api-keys","crud": {"read": false,"create": false,"update": false,"delete": false}}],"when_created": "2024-01-01T00:00:00Z","when_modified": "2024-01-01T00:00:00Z"}],"description": "string","account": {"address": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP","public_key": "string","type": "ED25519"},"when_created": "2024-01-01T00:00:00Z","when_modified": "2024-01-01T00:00:00Z"}
json
{"type": "object","description": "Organization entity representing a business or group structure within the platform","required": ["id","name","fqdn","fqdn","account","when_created","when_modified"],"properties": {"id": {"type": "string","description": "Unique identifier for the organization","x-oapi-codegen-extra-tags": {"json": "id,omitempty","bson": "_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"fqdn": {"type": "string","description": "Fully Qualified Domain Name associated with the organization","x-oapi-codegen-extra-tags": {"bson": "fqdn,omitempty"}},"name": {"type": "string","description": "Human-readable name of the organization","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"image": {"type": "object","description": "Represents a file or media asset stored in the platform","required": ["id","url"],"properties": {"id": {"type": "string","description": "Unique identifier for the asset","x-oapi-codegen-extra-tags": {"bson": "id,omitempty"}},"name": {"type": "string","description": "Human-readable name of the asset","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"type": {"type": "string","description": "MIME type of the asset (e.g., image/jpeg, application/pdf)","x-oapi-codegen-extra-tags": {"bson": "type,omitempty"}},"url": {"type": "string","description": "Public URL where the asset can be accessed","x-oapi-codegen-extra-tags": {"bson": "url,omitempty"}},"hash": {"type": "string","description": "Cryptographic hash of the asset content for integrity verification","x-oapi-codegen-extra-tags": {"bson": "hash,omitempty"}},"is_public": {"type": "boolean","description": "Whether the asset is publicly accessible without authentication","x-oapi-codegen-extra-tags": {"bson": "is_public,omitempty"}},"when_created": {"type": "string","format": "date-time","description": "Timestamp when the asset was uploaded","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"}}}},"members": {"type": "array","description": "List of members belonging to this organization","x-oapi-codegen-extra-tags": {"bson": "members,omitempty"},"items": {"type": "object","required": ["id","email","role_name","invite_status","when_created"],"properties": {"id": {"type": "string","x-oapi-codegen-extra-tags": {"json": "id,omitempty","bson": "_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"wallet_id": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "wallet_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"email": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "email,omitempty"}},"invite_status": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "invite_status,omitempty"},"enum": ["pending","accepted","declined"],"x-go-type-skip-optional-pointer": true},"role_name": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "role_name,omitempty"}},"when_created": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"},"format": "date-time"},"when_modified": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "when_modified,omitempty"},"format": "date-time","x-go-type-skip-optional-pointer": true}}},"x-go-type-skip-optional-pointer": true},"roles": {"type": "array","description": "List of roles defined within this organization","x-oapi-codegen-extra-tags": {"bson": "roles,omitempty"},"items": {"type": "object","required": ["id","name","permissions","when_created","when_modified"],"properties": {"id": {"type": "string","description": "Unique identifier for the role","x-oapi-codegen-extra-tags": {"json": "id,omitempty","bson": "_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"name": {"type": "string","description": "Human-readable name of the role","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"description": {"type": "string","description": "Optional detailed description of the role's purpose and scope","x-oapi-codegen-extra-tags": {"bson": "description,omitempty"},"x-go-type-skip-optional-pointer": true},"permissions": {"type": "array","description": "List of permissions assigned to this role","x-oapi-codegen-extra-tags": {"bson": "permissions,omitempty"},"items": {"type": "object","required": ["resource","crud"],"properties": {"resource": {"type": "string","x-oapi-codegen-extra-tags": {"bson": "resource,omitempty"},"enum": ["api-keys","ebus.actions","ebus.action-logs","faces","faces.pages","faces.assistant","indexer","notifications.templates","notifications.messages","objects","objects.state-changes","organizations","organizations.members","organizations.roles","sequencer.batches","stats.wallets","stats.objects","stats.actions","storage","templates","wallets","webhooks"]},"crud": {"type": "object","x-oapi-codegen-extra-tags": {"bson": "crud,omitempty"},"required": ["read","create","update","delete"],"properties": {"read": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "read,omitempty"}},"create": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "create,omitempty"}},"update": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "update,omitempty"}},"delete": {"type": "boolean","x-oapi-codegen-extra-tags": {"bson": "delete,omitempty"}}}}}}},"when_created": {"type": "string","description": "Timestamp when the role was created","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"},"format": "date-time"},"when_modified": {"type": "string","description": "Timestamp when the role was last modified","x-oapi-codegen-extra-tags": {"bson": "when_modified,omitempty"},"format": "date-time"}}},"x-go-type-skip-optional-pointer": true},"description": {"type": "string","description": "Optional detailed description of the organization's purpose and activities","x-oapi-codegen-extra-tags": {"bson": "description,omitempty"},"x-go-type-skip-optional-pointer": true},"account": {"description": "Blockchain account information associated with the organization","x-oapi-codegen-extra-tags": {"bson": "account,omitempty"},"type": "object","required": ["address","public_key","type"],"properties": {"address": {"type": "string","description": "The public address of the account."},"public_key": {"type": "string","description": "The public key of the account."},"type": {"type": "string","description": "The type of the account.","enum": ["ED25519","SECP256K1"]}}},"when_created": {"type": "string","description": "Timestamp when the organization was created","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"},"format": "date-time"},"when_modified": {"type": "string","description": "Timestamp when the organization was last modified","x-oapi-codegen-extra-tags": {"bson": "when_modified,omitempty"},"format": "date-time"}}}