get__organization_{orgId}
GET /organization/{orgId}
Get Organization Details
Retrieve organization details and settings for the specified organization. The authenticated user must be a member of the organization to access this information. This endpoint is accessible to all users within the organization regardless of their role.
TypeScript Client Library
// Note: This endpoint doesn't have a direct client method in the provided TypeScript client
// You would need to use the generic makeRequest method:
// this.makeRequest<any>(`organization/${orgId}`, 'GET', null);
Code Samples
# You can also use wget
curl -X GET https://backend.flashback.tech/organization/123e4567-e89b-12d3-a456-426614174000 \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses
200 Response
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Acme Corporation",
"domain": "acme.com",
"address1": "123 Business St",
"address2": "Suite 100",
"city": "New York",
"zipcode": "10001",
"phone": "+1-555-0123",
"state": "NY",
"country": "US",
"deletedAt": null,
"reposDisabled": false,
"website": "https://acme.com",
"is_business": true,
"mfaEnforced": true
}
}
403 Response
{
"success": false,
"data": null,
"message": "Access denied: you can only view your own organization"
}
404 Response
{
"success": false,
"data": null,
"message": "Organization not found"
}
500 Response
{
"success": false,
"data": null,
"message": "Internal server error"
}
Path Parameters
» orgId
string
true
Unique identifier of the organization to retrieve
Responses
Response Schema
Status Code 200
» success
boolean
false
none
Indicates if the request was successful
» data
object
false
none
Organization data
»» id
string
false
none
Unique identifier for the organization
»» name
string
false
none
Organization name
»» domain
string
false
none
Organization domain
»» address1
string
false
none
Primary address line
»» address2
string
false
none
Secondary address line
»» city
string
false
none
City
»» zipcode
string
false
none
ZIP/Postal code
»» phone
string
false
none
Phone number
»» state
string
false
none
State/Province
»» country
string
false
none
Country
»» deletedAt
string (date-time)
false
none
Deletion timestamp (null if active)
»» reposDisabled
boolean
false
none
Whether repositories are disabled
»» website
string
false
none
Organization website URL
»» is_business
boolean
false
none
Whether this is a business organization
»» mfaEnforced
boolean
false
none
Whether multi-factor authentication is enforced
Status Code 403
» success
boolean
false
none
Indicates if the request was successful
» data
null
false
none
No data returned
» message
string
false
none
Error message describing the access issue
Status Code 404
» success
boolean
false
none
Indicates if the request was successful
» data
null
false
none
No data returned
» message
string
false
none
Error message describing the issue
Status Code 500
» success
boolean
false
none
Indicates if the request was successful
» data
null
false
none
No data returned
» message
string
false
none
Error message describing the server issue
Security
BearerAuth: Bearer token authentication required
Organization Access: User must be a member of the specified organization
Role Requirements: No specific role requirements - accessible to all organization members
Notes
This endpoint returns basic organization information and settings
Organization settings are excluded from the response as requested
Users can only view their own organization's details
The
deletedAt
field indicates if the organization has been soft-deletedBusiness organizations may have different features and limitations than personal organizations
Last updated
Was this helpful?