Organizations
Last updated
Last updated
Who can use these endpoints
You can use an organization access token, see "Authenticating as an ICR organization". And you can also use an installation access token to access these endpoints using your ICR App. For more information, see "Authenticating as an ICR App installation." And
Metadata for an organization.
Gets base information on a specific organization.
Callable by any access token with permissions "organization_info:read".
Returns the inventory accounts that this organization owns. Default and subaccounts.
Gets the public wallet addresses of an organization. Mainly used for getting addresses to deposit credits into or to get inventory data for subaccounts.
Callable by any access token with permissions "organization_info:read".
This is the main inventory of an organization. Currently only "read" and "read and request" access are available for the inventory. The "read and request" access gives an app the permission to make transfer / retirement requests toward the credits in the organization's inventory.
This returns all the credits in an organization's inventory.
Callable by any access token with permissions "organization_inventory:read".
Creates a "transfer" / "retire" / "transfer_retire" transaction and puts it in the processing queue. To monitor the state of the transaction you can query the transaction endpoint.
Callable by any access token with permissions "organization_inventory:read_write".
Gets a specific transaction.
Callable by any access token with permissions "organization_inventory:read".
To get some test credits into your organization on the sandbox you can use this endpoint with and organization Id that you control. It will deposit a 100 credits into your organization.
Callable by any access token regardless of permissions.
This endpoint returns a list of the organization's inventory
/organizations/{id}/inventory
If defined returns the development inventory
API version
This endpoint creates a transaction for credits in the organization's inventory
/organizations/{id}/inventory/action/{action}
The action to perform on the token credit, one of transfer, retire, transfer_retire, cancel
transfer
, retire
, transfer_retire
, cancel
, issuance
, receive
, claim
, create_project
, create_vintages
The ID of the organization
123e4567-e89b-12d3-a456-426614174000
API version
The ID of the token credit
exPost-2-0x1234567890abcdef
The amount of the token credit
100
The ID of the organization receiving the token credit - if not provided, toAddress must be provided
123e4567-e89b-12d3-a456-426614174000
The address of the organization receiving the token credit - if not provided, toOrganizationId must be provided
0x1234567890abcdef
The retirement data associated with the token credit - only required for retirements
This endpoint returns an organization's transaction
/organizations/{id}/transactions/{transactionId}
API version
This endpoint sends 100 credits to the organization account that owns the calling api key. Only on testnet.
/organizations/{id}/friendbot
API version