Skip to main content

Retrieve portfolio

Retrieves detailed information about a specific portfolio by its unique ID.

HTTP Request​

GET/api/portfolios/:id

Authorization​

Authorization

  • Required: Yes
  • Permission: Staff with PorfolioPermission or Admin
  • Permission Code: 4202
  • Authentication: Token-based (Authorization: Token <your_api_key>)

Path Parameters​

ParameterTypeRequiredDescription
idIntegerYesUnique ID of the portfolio to retrieve

Example Requests​

1import requests
2
3# Retrieve a specific portfolio
4response = requests.get('http://www.example.com/api/portfolios/123', 
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())

Response Fields​

FieldTypeDescription
idIntegerUnique ID of the portfolio
titleStringportfolio title (unique)
slugStringunique slug of the portfolio
excerptStringShort description of the portfolio
orderIntegerDisplay order of the portfolio
image_dataObjectportfolio image details (nullable)
employer_dataObjectportfolio employer details (nullable)
tags_dataList(object)list of portfolio tags (nullable)
links_dataList(object)list of portfolio related links (nullable)
is_activeBooleanwhether the portfolio is active
completed_atIntegerThe time that the project has been finished/released/published
created_atString (ISO 8601)Timestamp when portfolio was created
updated_atString (ISO 8601)Timestamp when portfolio was last updated
descriptionStringfull description of the project (nullable)
images_dataList(object)list of gallery images objects (nullable)
metaList(objcet)list of meta objects (nullable)

Image Data Structure

FieldTypeDescription
idIntegerUnique ID of the image
typeStringFile type (e.g., image/jpeg)
nameStringOriginal file name
sizeIntegerFile size in bytes
human_readable_sizeStringHuman readable file size (e.g., 2.5 MB)
fStringURL to access the image file
widthIntegerImage width in pixels
heightIntegerImage height in pixels
modeStringColor mode (e.g., RGB, CMYK)
thumbnailsList of thumbnail objectsImgae thumbnails

Thumbnail Data Structure

FieldTypeDescription
idIntegerUnique ID of the thumbnail (unique)
fStringURL to access the thumbnail file
sizeIntegerFile size in bytes (nullable)

Client Data Structure

FieldTypeDescription
idIntegerUnique ID of the client
nameStringclient name (unique)
descriptionStringDescription of the client (nullable)
image_dataObjectclient image details

Tag Data Structure

FieldTypeDescription
idIntegerUnique ID of the tag
nameStringtag name (unique)
image_dataObjecttag image details

Link Data Structure

FieldTypeDescription
idIntegerUnique ID of the link
nameStringlink name (not unique)
urlURLFieldURL related to the link(nullable)
descriptionStringDescription of the link (nullable)
image_dataObjectlink image details

Meta Data Structure

FieldTypeDescription
idIntegerUnique ID of the meta data
keyStringThe key name of the meta data
value_textStringThe text value of the meta data
value_fileObjectThe file value of the meta data

Meta value_file data structure

FieldTypeDescription
idIntegerUnique ID of the file
typeStringThe type of the file
nameStringThe name of the file
sizeIntegerThe size of the file in bytes
human_readable_sizeStringThe human-readable size of the file
fStringThe url to the file

Example Response​

{
  "id": 148,
  "title": "web design",
  "slug": "web",
  "excerpt": "Sapiente veritatis ipsam ut ex minus nihil. Excepturi et beatae id repellendus dolor voluptatibus veniam aut nulla. Sed in illo explicabo nam.",
  "order": 1,
  "image_data": {
    "id": 88,
    "type": "image",
    "name": "test text",
    "size": 73062,
    "human_readable_size": "71.35 KB",
    "f": "http://localhost:8000/media/core_media/2026/03/02/image_test_media_file_0.bmp",
    "width": 156,
    "height": 156,
    "mode": "RGB",
    "thumbnails": [
      {
        "id": 229,
        "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_64x64.bmp",
        "size": 64
      },
      {
        "id": 230,
        "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_128x128.bmp",
        "size": 128
      },
      {
        "id": 231,
        "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_512x512.bmp",
        "size": 512
      },
      {
        "id": 232,
        "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_1080x1080.bmp",
        "size": 1080
      }
    ]
  },
  "employer_data": {
    "id": 1,
    "name": "digikala",
    "image_data": {
      "id": 88,
      "type": "image",
      "name": "test text",
      "size": 73062,
      "human_readable_size": "71.35 KB",
      "f": "http://localhost:8000/media/core_media/2026/03/02/image_test_media_file_0.bmp",
      "width": 156,
      "height": 156,
      "mode": "RGB",
      "thumbnails": [
        {
          "id": 229,
          "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_64x64.bmp",
          "size": 64
        },
        {
          "id": 230,
          "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_128x128.bmp",
          "size": 128
        },
        {
          "id": 231,
          "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_512x512.bmp",
          "size": 512
        },
        {
          "id": 232,
          "f": "http://localhost:8000/media/core_media/2026/03/02/thumbnails/image_test_media_file_0_thumbnail_1080x1080.bmp",
          "size": 1080
        }
      ]
    },
    "description": "some store"
  },
  "tags_data": [],
  "links_data": [
    {
      "id": 3,
      "name": "github",
      "url": "https://moeinsoft.com",
      "image_data": null,
      "description": ""
    },
    {
      "id": 4,
      "name": "site_url",
      "url": "https://digikala.com",
      "image_data": null,
      "description": "the website url"
    }
  ],
  "is_active": true,
  "completed_at": "2026-03-03T17:26:28Z",
  "created_at": "2026-03-03T17:26:52.642607Z",
  "updated_at": "2026-03-03T17:26:52.642613Z",
  "description": "asdf",
  "images_data": [],
  "meta": []
}