Account

These routes belong are responsible for managing business accounts.

Show Account

Show the details of a business account.

Endpoint

Method URI Authentication
GET /business/{unique_id}/account true

{success} Example Success Response Code 200

Content

{
    "success": true,
    "message": "Show business",
    "data": {
        "id": 1,
        "owner_id": 1,
        "unique_id": "ea11187b-fba5-31c8-87b4-84928c0334d6",
        "name": "Weyland-Yutani Corporation",
        "is_accepting_applications": true,
        "is_approved": false,
        "subdomain_prefix": "weyland-yutani",
        "stripe_connect_id": "acct_1F7RiLBKeAbZ6utM",
        "created_at": "2020-09-22T13:23:49.000000Z",
        "updated_at": "2020-09-22T13:23:51.000000Z",
        "deleted_at": null,
        "stripe_id": "cus_I4K7grXAClDEcl",
        "card_brand": "visa",
        "card_last_four": "4242",
        "trial_ends_at": null,
        "location": {
            "id": 1,
            "business_id": 1,
            "street_address": "997 Hettinger Ports",
            "city": "Rochester",
            "state": "MN",
            "zip": "55901",
            "lat": 44.0446131,
            "long": -92.4841607,
            "created_at": "2020-09-22T13:23:54.000000Z",
            "updated_at": "2020-09-22T13:23:54.000000Z"
        },
        "profile": {
            "id": 1,
            "business_id": 1,
            "image": "https:\/\/gigwerk-disk.s3.amazonaws.com\/seed\/weyland-yutani.png",
            "cover": "https:\/\/gigwerk-disk.s3.amazonaws.com\/roch.jpg",
            "short_description": "Building better worlds",
            "long_description": "Primarily a technology supplier, manufacturing synthetics, spaceships and computers for a wide range of industrial and commercial clients",
            "primary_color": "/docs/1.0/business/account#a04c5a",
            "secondary_color": "/docs/1.0/business/account#002200",
            "created_at": "2020-09-22T13:23:54.000000Z",
            "updated_at": "2020-09-22T13:23:54.000000Z"
        }
    }
}

Update Profile

This updates a businesses profile.

Endpoint

Method URI Authentication
PATCH /business/{unique_id}/account true

Body Params

Name Type Status Description
name string optional Update the name of the business
image base64 optional Update the profile image of the business.
cover base64 optional Update the cover image of the business.
short_description string optional Update the headline of the business.
long_description string optional Update the description of the business.
primary_color string optional Update the primary color of your business app
secondary_color string optional Update the secondary color of your business app
is_accepting_applications boolean optional Update if your business is accepting applications or not

{success} Example Success Response Code 200

Content

{
    "success": true,
    "message": "Your business has been updated",
    "data": null
}

Update Location

Update the location of the business.

Endpoint

Method URI Authentication
PATCH /business/{unique_id}/location true

Body Params

Name Type Status Description
street_address string optional The address of the job location
city string optional The city of the job location.
state string optional The state of the job location.
zip string optional The zip code of the job location.

{success} Example Success Response Code 200

Content

{
    "success": true,
    "message": "Your business location has been updated",
    "data": null
}

Stripe Login

Login or create Stripe Connect account for a business.

Endpoint

Method URI Authentication
GET /business/{unique_id}/stripe true

{success} Example Success Response Code 200

Content

{
    "success": true,
    "message": "Stripe OAuth link created",
    "data": {
        "url": "https:\/\/connect.stripe.com\/express\/isEjQmCaS7aj"
    }
}